Class ScriptModuleImpl

All Implemented Interfaces:
IPCObject, ScriptModule, CepInstance

public class ScriptModuleImpl extends CepInstanceImpl implements ScriptModule
Information provided by the PKI file:

    \class CScriptModule
    
    \brief      CScriptModule access from itself.
    
    \example ipcManager().thisInstance()
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • stop

      public boolean stop()
      Information provided by the PKI file:
      
          \brief Stop Script Module
          
          \return bool, true if it has been stopped and false if otherwise
          
              
      Specified by:
      stop in interface ScriptModule
      Returns:
      boolean Returns a boolean
    • getScriptCode

      public String getScriptCode(String id)
      Information provided by the PKI file:
      
          \brief Get Script Code based on script id
          
          \param id, script id
          
          \return QString, Script code
          
              
      Specified by:
      getScriptCode in interface ScriptModule
      Parameters:
      id - Takes in a parameter of id
      Returns:
      String Returns a String
    • getScript

      public String getScript(String id)
      Information provided by the PKI file:
      
          \brief Get Script Code based on script id and processes translations on the code, if exists.
          
          \param id, script id
          
          \return QString, processed Script code
          
              
      Specified by:
      getScript in interface ScriptModule
      Parameters:
      id - Takes in a parameter of id
      Returns:
      String Returns a String
    • hasScript

      public boolean hasScript(String id)
      Information provided by the PKI file:
      
          \brief Check if the script exists using script id
          
          \param id, script id
          
          \return bool, true if it exists and false otherwise
          
              
      Specified by:
      hasScript in interface ScriptModule
      Parameters:
      id - Takes in a parameter of id
      Returns:
      boolean Returns a boolean
    • getInterfaceCode

      public String getInterfaceCode(String id)
      Information provided by the PKI file:
      
          \brief Get Interface Code based on Interface id..
          
          \param id, Interface id
          
          \return QString, Interface code
          
              
      Specified by:
      getInterfaceCode in interface ScriptModule
      Parameters:
      id - Takes in a parameter of id
      Returns:
      String Returns a String
    • getInterface

      public String getInterface(String id)
      Information provided by the PKI file:
      
          \brief Get Interface Code based on Interface id and processes translations on the code, if exists.
          
          \param id, Interface id
          
          \return QString, processed Interface code
          
              
      Specified by:
      getInterface in interface ScriptModule
      Parameters:
      id - Takes in a parameter of id
      Returns:
      String Returns a String
    • hasInterface

      public boolean hasInterface(String id)
      Information provided by the PKI file:
      
          \brief Check if the Interface exists using Interface id
          
          \param id, Interface id
          
          \return bool, true if it exists and false otherwise
          
              
      Specified by:
      hasInterface in interface ScriptModule
      Parameters:
      id - Takes in a parameter of id
      Returns:
      boolean Returns a boolean
    • getScriptDataStore

      public String getScriptDataStore(String id)
      Specified by:
      getScriptDataStore in interface ScriptModule
      Parameters:
      id - Takes in a parameter of id
      Returns:
      String Returns a String
    • shouldPromptExternalNetworkAccess

      public boolean shouldPromptExternalNetworkAccess()
      Information provided by the PKI file:
      
          \brief This delegate determines if script module should prompt for external network access.
          
          \return bool, true if script module should prompt, otherwise false.
          
              
      Specified by:
      shouldPromptExternalNetworkAccess in interface ScriptModule
      Returns:
      boolean Returns a boolean
    • shouldPromptExternalServerOperation

      public boolean shouldPromptExternalServerOperation(String protocol, int port)
      Information provided by the PKI file:
      
          \brief This delegate determines if script module should prompt for external server operation.
          
          \param protocol, HTTP or TCP
          \param port, the port to listen on
          
          \return bool, true if script module should prompt, otherwise false.
          
              
      Specified by:
      shouldPromptExternalServerOperation in interface ScriptModule
      Parameters:
      protocol - Takes in a parameter of protocol
      port - Takes in a parameter of port
      Returns:
      boolean Returns a boolean